<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>iomodule: xiomodule_uart_intr.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">iomodule
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xiomodule__uart__intr_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xiomodule_uart_intr.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gabe2219bbd76d37299ef7e645133bd74f"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iomodule.html#gabe2219bbd76d37299ef7e645133bd74f">XIOModule_Send</a> (<a class="el" href="struct_x_i_o_module.html">XIOModule</a> *InstancePtr, u8 *DataBufferPtr, u32 NumBytes)</td></tr>
<tr class="memdesc:gabe2219bbd76d37299ef7e645133bd74f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This functions sends the specified buffer of data using the UART in either polled or interrupt driven modes.  <a href="group__iomodule.html#gabe2219bbd76d37299ef7e645133bd74f">More...</a><br/></td></tr>
<tr class="separator:gabe2219bbd76d37299ef7e645133bd74f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3840262ec8f698849bf0bba791c978a8"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iomodule.html#ga3840262ec8f698849bf0bba791c978a8">XIOModule_Recv</a> (<a class="el" href="struct_x_i_o_module.html">XIOModule</a> *InstancePtr, u8 *DataBufferPtr, u32 NumBytes)</td></tr>
<tr class="memdesc:ga3840262ec8f698849bf0bba791c978a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function will attempt to receive a specified number of bytes of data from the UART and store it into the specified buffer.  <a href="group__iomodule.html#ga3840262ec8f698849bf0bba791c978a8">More...</a><br/></td></tr>
<tr class="separator:ga3840262ec8f698849bf0bba791c978a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadabb5f2e09817afb284173f31f3d7265"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iomodule.html#gadabb5f2e09817afb284173f31f3d7265">XIOModule_ResetFifos</a> (<a class="el" href="struct_x_i_o_module.html">XIOModule</a> *InstancePtr)</td></tr>
<tr class="memdesc:gadabb5f2e09817afb284173f31f3d7265"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function does nothing, since the UART doesn't have any FIFOs.  <a href="group__iomodule.html#gadabb5f2e09817afb284173f31f3d7265">More...</a><br/></td></tr>
<tr class="separator:gadabb5f2e09817afb284173f31f3d7265"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0e055e6172c30e7acbfde08aeed10fa1"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iomodule.html#ga0e055e6172c30e7acbfde08aeed10fa1">XIOModule_IsSending</a> (<a class="el" href="struct_x_i_o_module.html">XIOModule</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga0e055e6172c30e7acbfde08aeed10fa1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function determines if the specified UART is sending data.  <a href="group__iomodule.html#ga0e055e6172c30e7acbfde08aeed10fa1">More...</a><br/></td></tr>
<tr class="separator:ga0e055e6172c30e7acbfde08aeed10fa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1fc16de9c0cbaad1d3022d19a0d883cd"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iomodule.html#ga1fc16de9c0cbaad1d3022d19a0d883cd">XIOModule_SendBuffer</a> (<a class="el" href="struct_x_i_o_module.html">XIOModule</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga1fc16de9c0cbaad1d3022d19a0d883cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends a buffer that has been previously specified by setting up the instance variables of the instance.  <a href="group__iomodule.html#ga1fc16de9c0cbaad1d3022d19a0d883cd">More...</a><br/></td></tr>
<tr class="separator:ga1fc16de9c0cbaad1d3022d19a0d883cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga70b12729029fff571ad8915dc30897d6"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iomodule.html#ga70b12729029fff571ad8915dc30897d6">XIOModule_ReceiveBuffer</a> (<a class="el" href="struct_x_i_o_module.html">XIOModule</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga70b12729029fff571ad8915dc30897d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function receives a buffer that has been previously specified by setting up the instance variables of the instance.  <a href="group__iomodule.html#ga70b12729029fff571ad8915dc30897d6">More...</a><br/></td></tr>
<tr class="separator:ga70b12729029fff571ad8915dc30897d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5ece62521d0d34bd420888ecc876750c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iomodule.html#ga5ece62521d0d34bd420888ecc876750c">XIOModule_SetRecvHandler</a> (<a class="el" href="struct_x_i_o_module.html">XIOModule</a> *InstancePtr, <a class="el" href="group__iomodule.html#ga40a7295554b9483f28c0f004b0c53302">XIOModule_Handler</a> FuncPtr, void *CallBackRef)</td></tr>
<tr class="memdesc:ga5ece62521d0d34bd420888ecc876750c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the handler that will be called when an event (interrupt) occurs in the driver for the UART.  <a href="group__iomodule.html#ga5ece62521d0d34bd420888ecc876750c">More...</a><br/></td></tr>
<tr class="separator:ga5ece62521d0d34bd420888ecc876750c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga07b376ebf11fee3ff027445eaa096261"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iomodule.html#ga07b376ebf11fee3ff027445eaa096261">XIOModule_SetSendHandler</a> (<a class="el" href="struct_x_i_o_module.html">XIOModule</a> *InstancePtr, <a class="el" href="group__iomodule.html#ga40a7295554b9483f28c0f004b0c53302">XIOModule_Handler</a> FuncPtr, void *CallBackRef)</td></tr>
<tr class="memdesc:ga07b376ebf11fee3ff027445eaa096261"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the handler that will be called when an event (interrupt) occurs in the driver for the UART.  <a href="group__iomodule.html#ga07b376ebf11fee3ff027445eaa096261">More...</a><br/></td></tr>
<tr class="separator:ga07b376ebf11fee3ff027445eaa096261"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacf2a67095f9797403f5c269fdcd7a6b2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iomodule.html#gacf2a67095f9797403f5c269fdcd7a6b2">XIOModule_Uart_InterruptHandler</a> (<a class="el" href="struct_x_i_o_module.html">XIOModule</a> *InstancePtr)</td></tr>
<tr class="memdesc:gacf2a67095f9797403f5c269fdcd7a6b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the interrupt handler for the UART.  <a href="group__iomodule.html#gacf2a67095f9797403f5c269fdcd7a6b2">More...</a><br/></td></tr>
<tr class="separator:gacf2a67095f9797403f5c269fdcd7a6b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5ec72d0dd352ad42de494821220e3185"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iomodule.html#ga5ec72d0dd352ad42de494821220e3185">XIOModule_Uart_DisableInterrupt</a> (<a class="el" href="struct_x_i_o_module.html">XIOModule</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga5ec72d0dd352ad42de494821220e3185"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function disables the UART interrupt.  <a href="group__iomodule.html#ga5ec72d0dd352ad42de494821220e3185">More...</a><br/></td></tr>
<tr class="separator:ga5ec72d0dd352ad42de494821220e3185"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa805a7f9982d9acc5b3b16849c5d2dfd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__iomodule.html#gaa805a7f9982d9acc5b3b16849c5d2dfd">XIOModule_Uart_EnableInterrupt</a> (<a class="el" href="struct_x_i_o_module.html">XIOModule</a> *InstancePtr)</td></tr>
<tr class="memdesc:gaa805a7f9982d9acc5b3b16849c5d2dfd"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables the UART interrupts such that an interrupt will occur when data is received or data has been transmitted.  <a href="group__iomodule.html#gaa805a7f9982d9acc5b3b16849c5d2dfd">More...</a><br/></td></tr>
<tr class="separator:gaa805a7f9982d9acc5b3b16849c5d2dfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
